BBS Toolkit/BBS Toolkit.iso/doors_1/gapbank.zip/BANK.DOC

Text File | 1992-06-22 | 17KB | 401 lines

                                 Time Bank v1.8
            Written by Mike May ■ Copyright 1991,92 ■ Chump Software
               The Ice House BBS ■ P.O. Box 545 Rialto, CA 92377
       714-874-7254 HST ■ 714-874-7290 D/S v.32 ■ 714-874-7255 CompuComs
     ---------------------------------------------------------------------
     Features
     ========

       √  Allows callers to deposit extra time and withdraw it at a
          later date.

       √  Allows Sysop to set different amounts of time saved per
          security level.

       √  Allows Sysop to provide caller with extra time even if Sysop
          is not around.

       √  Sysop controllable limit on time deposited.

       √  Written to work directly with GAP 5.0 and above.

       √  Extensive use of ANSI color if the caller has color enabled.

       √  Completely event aware. Won't allow time to be withdrawn that might
          interfere with a scheduled BBS event. Reads events directly from
          GAP's EVENTS.DAT file.

       √  Multi-node capability. No 'File Access Denied' errors.

       √  Time Bank editor included. Allows adding caller accounts, editing
          callers accounts or disabling callers accounts entirely. Uses pull
          down menus and has the 'GAP' look.

       √  Does NOT require DTR patched BRUN45.EXE.

       √  Supports modem speeds up to 38.4k and locked ports. Works with
          virtually all modems including HSTs, DSs and CompuComs!

       √  Includes carrier detection. Will simply return to the BBS if the
          caller drops carrier.

       √  Informative Status Line display.

       √  Monitors keyboard activity and returns caller to BBS if no activity.

       √  Sysop chat with full word wrapping.

       √  Creates individual logs per node for tracking.

       √  Best feature of all, it's only $10 and NOT crippled before
          registration!






     General Info
     ============

     Files included in this .ZIP:

         BANK.EXE          The Time Bank program itself.
         BANK.DOC          What you're reading now.
         BANK.CFG          Sample configuration file, must be edited if used.
         BANKEDIT.EXE      The Time Bank Editor.
         READ.ME           Any last minute additions.
         HISTORY.TXT       List of revisions.
         REGISTER.FRM      Registration Form.

     Files created by program:

         BANK.DAT          Stores all the info needed about a caller.
                           Erase it and no one has any time stored!

         BANKLOG.x         Complete logging of activity. x represents node
                           number.

     Set-up
     ======

         Start by creating a new configuration file or modifying the one
     included in the ZIP package. This file consists of at least 4 lines.

     C:\GAP               BBS default directory, the location of DOOR.SYS.
     The Ice House        Name of your BBS.
     0                    This must always be a zero!
     30                   Default maximum number of minutes a caller can save.
     110,90    ────┐
     60,60         │      Up to 10 additional lines with the format:
     50,45         ├───   Security Level, Maximum Time Allowable.
     ...           │      Any caller with a level not included here will
     ...           │      receive minutes from line 4. (30 in this case.)
     10,20     ────┘


         This file must be saved in ASCII format and be located in the same
     directory as the BANK.EXE, preferably in its own directory. To start
     the Time Bank you simply call it with the name of the configuration
     file on the command line, example: BANK BANK.CFG

         If you fail to supply a configuration filename on the command line
     then BANK.CFG will be used as a default. Time Bank also includes complete
     file locking for multiple nodes. There's no worry about the data file
     being open while multiple nodes try to access it. Setup is similar to
     the above instructions except you'll need a configuration file for each
     node since each node has a different BBS default directory. The
     configuration files can be called whatever you like. I use BANK1.CFG,
     BANK2.CFG etc. Each file will be identical except for the first line.





     Example:

         BANK1.CFG might look like:

     C:\GAP
     The Ice House
     0
     30
     110,90
     60,60
     50,45

         and BANK2.CFG might look like:

     D:\GAP
     The Ice House
     0
     30
     110,90
     60,60
     50,45

         Then you would call the Time Bank like this on node 1:

     @ECHO OFF
     C:
     CD\BANK    <--- if this is the directory where you put all the files
     BANK BANK1.CFG

         or like this on node 2:

     @ECHO OFF
     C:
     CD\BANK    <--- if this is the directory where you put all the files
     BANK BANK2.CFG

         You can have as many configuration files as are necessary for your
     particular BBS setup.

         You will  also need  to modify your doors menu files and the data
     file that tells the BBS what your doors are and the security level
     needed to access them. These are:

         DOORM
         DOORMG
         DOORS.DAT

        An alternative to setting Time Bank up as a door would be to use GAPs
     sysop definable commands. I use BANK from the File Menu since that's where
     most 'time-hawgs' will be anyway!

         Please refer to your BBS documentation for details on setting
     these files up.





     Sysop Functions
     ===============

         The following sysop functions are available while awaiting
     keyboard input :

                        F5     -  Shell to DOS.
                        F8     -  Twit user and return to BBS.
                       F10     -  Initiate chat with user.
                       CF10    -  Answer user page bell.
                       Home    -  Main user stats.
                       End     -  Displays sysop keys available.
                       PgDn    -  Secondary user stats.
                     Up Arrow  -  Increase user's time remaining.
                     Dn Arrow  -  Decrease user's time remaining.

         One of the nicer features about using the TWIT key, is the user is
     not told that "the sysop wants them to return to the BBS". Instead a
     very plain and simple message of "returning you to the BBS" is
     displayed. This way, the user is given no indication that the sysop is
     hovering about.

         When using the F5 shell to DOS key, to return to the door program,
     simply type EXIT at the DOS command prompt. It is not necessary to
     change directories back to the door directory. If the screen is
     incomplete after returning, use the R command from the Time Bank menu to
     R)edisplay the menu.

         The Up and Down Arrow keys increase and decrease the user's time
     respectively by 5 minutes for each press of the key. There is not much
     use for this since any time added will NOT be made available to the
     caller while in the door or after they've exited the door. But heck, it
     was part of the library!


     Operation
     =========

         Once a caller has opened the door they are presented with a single
     screen that gives them some basic information along with the amount of
     time that they may deposit. This time is either the amount of time they
     have left minus 5 minutes or the difference between the maximum amount
     of time the door allows for deposit and the amount already in their
     account, whichever is smaller.

         If the amount of time in their account would conflict with a
     scheduled BBS event then the Withdrawal option will be disabled.
     Otherwise the time remaining will be displayed along with the Withdrawal,
     Deposit and Quit choices. It's pretty self-explanatory from this point.





         Entering a 1 will allow a withdrawal to be made. The maximum amount
     in the bank will be offered as a default. Pressing <ENTER> will indicate
     this amount. Any other amount may be entered manually. Of course if it's
     more than the amount in the account it will be discarded!

         Entering a 2 will allow for a deposit. The maximum amount left to
     be deposited will be offered as a default. Pressing <ENTER> will
     indicate this amount. Again, any other amount may be entered so long
     as the caller has that amount to deposit and it doesn't exceed the
     limit set by the sysop. Entering Q will simply exit the door and return
     the caller to the BBS. Although not visible on the menu, entering R
     will redisplay the screen, useful if the sysop has dropped to DOS or if
     the screen became garbled for some reason.

         Keyboard is monitored so that after 4 minutes of inactivity the
     caller will be returned to the BBS. A dropped carrier will also return
     the caller to the BBS where GAP will recycle.

         Just so you don't think you're going crazy, yes, the border of the
     Time Bank does come up in different colors every time it is used. I
     figured no one wanted to see the same color every time!

         That's about all there is to it. Very simple to use and maintain!


     Time Bank Editor
     ================

         The Time Bank editor is a utility program for the Time Bank that
     will let you make modifications to the Time Bank data file without
     having to log on as the caller and doing it manually. To run the program
     simply copy it to your Time Bank directory and type BANKEDIT. Do NOT run
     BANKEDIT while there exists the possibility of someone using the door or
     else you run a very high risk of trashing the data file!  After starting
     BANKEDIT you'll have the following options: Edit, Pack and Quit.

     Edit

         Edit will go to a sub menu of 3 more options. Edit, Add and Delete.

         Edit - will pop up a scrolling list of all callers that have an
     account along with the time they have already deposited in the bank. Use
     the arrows keys to move to the caller you want to edit and press <ENTER>.
     You'll then be given an opportunity to modify the callers amount. Enter
     whatever amount you desire. If you do input an amount higher than the
     maximum amount as indicated in your configuration file, the caller will
     be able to withdraw the amount but will NOT be able to deposit any more
     than the maximum. Pressing <ESC> will abort the change. Obviously you
     can remove all of a callers stored time by changing their time to 0.




         Add - will just ask you the name of the caller to add and the amount
     to deposit for them. Same rules apply as above if you give them more
     time than the maximum as indicated in your configuration file. Pressing
     <ESC> will abort this function. If the person already exists in the
     database you will be notified and returned. This function can also be
     used to set up an account for someone that is not a member of your
     BBS...yet. When they call for the first time they can withdraw whatever
     time you have deposited for them ahead of time. An easy way to allow
     first time callers with more time than your 'normal' first time caller.
     Or suppose you get one of those "Can I have more time to download
     the BRANDX.ZIP file. I'll be back tomorrow." messages. You can simply
     set up the caller with some extra time and not worry about being around
     when they call or changing their security level around.

         Disable - will also pop up a scrolling list of users with accounts.
     Use the arrow keys to move to the account you want disabled and press
     <ENTER>. A confirmation message will pop up. Press Y to disable the
     callers account or any other key to exit. Disabled accounts are indicated
     by a -1 in the time field. What this indicates to the Time Bank is that
     this caller is an 'undesirable'. Meaning that you don't want them to use
     the bank at all. When an undesirable caller tries to use the bank he is
     told that an event is pending and all options except Quit are disabled.

     Pack

         Pack - will reorganize the Time Bank database to remove all of the
     accounts with 0 minutes or accounts that are disabled. This is provided
     simply to keep the size of the database under control.

     Quit

         Quit - Leave the editor.

         The Time Bank editor will always make a copy of your database before
     any modifications are attempted. If you run the editor and find that the
     database file became corrupted for whatever reason, look in the Time
     Bank directory for the file BANK.SAV. Rename this file to BANK.DAT and
     you'll be back in business.

     *** Note that in all of the scrolling windows you can enter the first
     character of the name you want and the hilited bar will jump to that name.
     You can do this repeatedly until you find who you're looking for. Example,
     if you have a Tom, a Tim, a Tony, and another Tom, pressing T anywhere in
     the list will take you to the first T name, pressing T again will take you
     to the next T name, etc.





     Registration
     ============

         The Time Bank represents many hours of programming and the author
     deserves just compensation for his time, efforts and expertise. If you
     find this program to be of some value and you continue to use it on your
     BBS system beyond 30 days you must return the registration form provided
     along with the registration fee. Registration entitles you to free
     upgrades via modem from The Ice House BBS. Payments should be made in
     the form of a check or money order (do NOT send cash!). Foreign orders
     must be in U.S. funds drawn on a U.S. bank. Online registration is
     available with VISA/MasterCard by calling The Ice House - 714-874-7254.

         Upon receipt of the registration fee a file will be made available
     on The Ice House BBS that will be put in your Time Bank directory that
     will remove the registered to No One line and replace it with the Sysops
     name.

         Of course if you're a door author yourself and have something that I
     might be able to use, I'll be more than happy to trade registrations.

         Registration is only $10. Nothing is crippled before registration so
     you'll gain no features other than having your name appear on the bank
     screen. I think after running the program and editor for a few days you'll
     agree that it's worth the price. I debated whether I should include the
     editor before registration, but what the heck, hopefully the editor will
     convince some sysops to register.


     Distribution
     ============

         You are free, in fact encouraged, to distribute the Time Bank
     provided that all files contained in the original Time Bank archive
     are distributed in their original unmodified state.


     Thanks
     ======

         Thanks go to GAP development for their excellent GAPQBDR library
     that made 90% of this door possible. Thanks also to GAP development for
     bringing us GAP in the first place. GAP is the choice of 'real' sysops
     everywhere! Thanks to Kenny for letting me steal the GAP 'Look & Feel'!

     Thanks also go to the beta testers:

     Tony Summy - The Main Shop       Jim Pierce - ECTech





     Warranty
     ========

         This is product is provided "as is" without warranty of any kind.
     The entire risk as to the results and performance of the program is
     assumed by you. Furthermore, I the author do not warrant, guarantee, or
     make any representations regarding the use of, or the results of the use
     of the program, and you rely on the program and results solely at your
     own risk.  I the author cannot accept responsibility for system damage,
     loss of profit, or any other special, incidental, or consequential
     damages resulting from the use or inability to use this product. But
     then you already knew that, right?